/**
 * Copyright © 2008, EMC Corporation.
 * Redistribution and use in source and binary forms, with or without modification, 
 * are permitted provided that the following conditions are met:
 *
 *     + Redistributions of source code must retain the above copyright notice, 
 *       this list of conditions and the following disclaimer.
 *     + Redistributions in binary form must reproduce the above copyright 
 *       notice, this list of conditions and the following disclaimer in the 
 *       documentation and/or other materials provided with the distribution.
 *     + The name of EMC Corporation may not be used to endorse or promote 
 *       products derived from this software without specific prior written 
 *       permission.
 *
 *      THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
 *      "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 
 *      TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
 *      PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS 
 *      BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 *      CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
 *      SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
 *      INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *      CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 *      ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 *      POSSIBILITY OF SUCH DAMAGE.
 */
package com.emc.esu.api {
	/**
 	 * Encapsulates a ESU object identifier.  Performs validation upon construction
 	 * to ensure that the identifier format is valid.  
 	 */
	public class ObjectId extends Identifier {
	    /**
	     * Regular expression used to validate identifiers.
	     */
	    private static const ID_FORMAT:RegExp = /^[0-9a-f]{44}$/;
	    
	    /**
	     * Stores the string representation of the identifier
	     */
	    private var _id:String;
	
	    /**
	     * Constructs a new object identifier
	     * @param id the object ID as a string
	     */
	    public function ObjectId( id:String ) {
	        if( !ID_FORMAT.test( id ) ) {
	            throw new EsuError( id + " is not a valid object id" );
	        }
	        this._id = id;
	    }
	    
	    /**
	     * Returns the identifier as a string
	     * @return the identifier as a string
	     */
	    public function toString():String {
	        return _id;
	    }
	    
	    /**
	     * Returns true if the object IDs are equal.
	     */
	    public function equals( obj:Object ):Boolean {
	        if( !(obj is ObjectId) ) {
	            return false;
	        }
	        
	        return _id == obj.toString();
	        
	    }
	    
	    /**
	     * Finds the index of an ObjectId in an array
	     */
	    public static function findInArray( id:ObjectId, arr:Array ):int {
	    	for( var i:int=0; i<arr.length; i++ ) {
	    		if( id.equals( arr[i] ) ) {
	    			return i;
	    		}
	    	}
	    	
	    	
	    	return -1;
	    }
	    
	    public function get id():String {
	    	return this._id;
	    }
	}
}